GET api/bfg/v1/orders?clientIDs[0]={clientIDs[0]}&clientIDs[1]={clientIDs[1]}&status[0]={status[0]}&status[1]={status[1]}
Get client orders
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientIDs | Collection of integer |
Required |
|
| status | Collection of enOrderStatus |
Required |
Body Parameters
None.
Response Information
Resource Description
List of orders
Collection of Order| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderID | integer |
None. |
|
| SecurityCode | string |
None. |
|
| ExchangeCode | string |
None. |
|
| CurrencyCode | string |
None. |
|
| BuySell | string |
None. |
|
| Quantity | integer |
None. |
|
| QuantityBooked | integer |
None. |
|
| QuantityFilled | integer |
None. |
|
| OrderStatus | string |
None. |
|
| CreatedTimeStamp | date |
None. |
|
| VolumeWeightedAveragePrice | decimal number |
None. |
|
| PriceType | string |
None. |
|
| Price | decimal number |
None. |
|
| TotalCost | decimal number |
None. |
|
| Brokerage | decimal number |
None. |
|
| Creator | string |
None. |
|
| ExpiryDate | date |
None. |
|
| CompletedTimeStamp | date |
None. |
|
| NotesForClient | string |
None. |
|
| OrderGiver | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"OrderID": 1,
"SecurityCode": "sample string 2",
"ExchangeCode": "sample string 3",
"CurrencyCode": "sample string 4",
"BuySell": "sample string 5",
"Quantity": 6,
"QuantityBooked": 7,
"QuantityFilled": 8,
"OrderStatus": "sample string 9",
"CreatedTimeStamp": "2026-09-16T20:30:34.0535804+10:00",
"VolumeWeightedAveragePrice": 1.0,
"PriceType": "sample string 11",
"Price": 1.0,
"TotalCost": 1.0,
"Brokerage": 1.0,
"Creator": "sample string 12",
"ExpiryDate": "2026-09-16T20:30:34.0545765+10:00",
"CompletedTimeStamp": "2026-09-16T20:30:34.0545765+10:00",
"NotesForClient": "sample string 13",
"OrderGiver": "sample string 14"
},
{
"OrderID": 1,
"SecurityCode": "sample string 2",
"ExchangeCode": "sample string 3",
"CurrencyCode": "sample string 4",
"BuySell": "sample string 5",
"Quantity": 6,
"QuantityBooked": 7,
"QuantityFilled": 8,
"OrderStatus": "sample string 9",
"CreatedTimeStamp": "2026-09-16T20:30:34.0535804+10:00",
"VolumeWeightedAveragePrice": 1.0,
"PriceType": "sample string 11",
"Price": 1.0,
"TotalCost": 1.0,
"Brokerage": 1.0,
"Creator": "sample string 12",
"ExpiryDate": "2026-09-16T20:30:34.0545765+10:00",
"CompletedTimeStamp": "2026-09-16T20:30:34.0545765+10:00",
"NotesForClient": "sample string 13",
"OrderGiver": "sample string 14"
}
]
application/xml, text/xml
Sample:
<ArrayOfOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
<Order>
<Brokerage>1</Brokerage>
<BuySell>sample string 5</BuySell>
<CompletedTimeStamp>2026-09-16T20:30:34.0545765+10:00</CompletedTimeStamp>
<CreatedTimeStamp>2026-09-16T20:30:34.0535804+10:00</CreatedTimeStamp>
<Creator>sample string 12</Creator>
<CurrencyCode>sample string 4</CurrencyCode>
<ExchangeCode>sample string 3</ExchangeCode>
<ExpiryDate>2026-09-16T20:30:34.0545765+10:00</ExpiryDate>
<NotesForClient>sample string 13</NotesForClient>
<OrderGiver>sample string 14</OrderGiver>
<OrderID>1</OrderID>
<OrderStatus>sample string 9</OrderStatus>
<Price>1</Price>
<PriceType>sample string 11</PriceType>
<Quantity>6</Quantity>
<QuantityBooked>7</QuantityBooked>
<QuantityFilled>8</QuantityFilled>
<SecurityCode>sample string 2</SecurityCode>
<TotalCost>1</TotalCost>
<VolumeWeightedAveragePrice>1</VolumeWeightedAveragePrice>
</Order>
<Order>
<Brokerage>1</Brokerage>
<BuySell>sample string 5</BuySell>
<CompletedTimeStamp>2026-09-16T20:30:34.0545765+10:00</CompletedTimeStamp>
<CreatedTimeStamp>2026-09-16T20:30:34.0535804+10:00</CreatedTimeStamp>
<Creator>sample string 12</Creator>
<CurrencyCode>sample string 4</CurrencyCode>
<ExchangeCode>sample string 3</ExchangeCode>
<ExpiryDate>2026-09-16T20:30:34.0545765+10:00</ExpiryDate>
<NotesForClient>sample string 13</NotesForClient>
<OrderGiver>sample string 14</OrderGiver>
<OrderID>1</OrderID>
<OrderStatus>sample string 9</OrderStatus>
<Price>1</Price>
<PriceType>sample string 11</PriceType>
<Quantity>6</Quantity>
<QuantityBooked>7</QuantityBooked>
<QuantityFilled>8</QuantityFilled>
<SecurityCode>sample string 2</SecurityCode>
<TotalCost>1</TotalCost>
<VolumeWeightedAveragePrice>1</VolumeWeightedAveragePrice>
</Order>
</ArrayOfOrder>